/*!
 *****************************************************************************
 * @file:    AD5270.h
 * @brief:   AD5270 rheostat
 * @version: $Revision$
 * @date:    $Date$
 *-----------------------------------------------------------------------------
 *
Copyright (c) 2016-2017 Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
  - Redistributions of source code must retain the above copyright notice,
    this list of conditions and the following disclaimer.
  - Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
  - Modified versions of the software must be conspicuously marked as such.
  - This software is licensed solely and exclusively for use with processors
    manufactured by or for Analog Devices, Inc.
  - This software may not be combined or merged with other code in any manner
    that would cause the software to become subject to terms and conditions
    which differ from those listed here.
  - Neither the name of Analog Devices, Inc. nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.
  - The use of this software may or may not infringe the patent rights of one
    or more patent holders.  This license does not release you from the
    requirement that you obtain separate licenses from these patent holders
    to use this software.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/

#ifndef AD5270_H
#define AD5270_H

#include <stdint.h>

#define MAX_RESISTANCE                    20000.0
#define WRITE_OPERATION_50TP_TIMEOUT      350
#define MEMORY_OPERATION_TIMEOUT          6
#define REG_OPERATION_TIMEOUT             2

#define SHIFT_REG  // 16 bits

    /// AD5270 commands
    typedef enum {
        NO_OP               =  0x00,    ///< No data
        NO_OP_cmd           =  0x0000,  ///< 16 bit no data
        WRITE_RDAC          =  0x04,    ///< Write to the RDAC Register
        READ_RDAC           =  0x08,    ///< Read from the RDAC Register
        STORE_50TP          =  0x0C,    ///< Store RDAC setting to 50-TP
        SW_RST              =  0x10,    ///< Software reset to last memory location
        READ_50TP_CONTENTS  =  0x14,    ///< Read the last memory contents
        READ_50TP_ADDRESS   =  0x18,    ///< Read the last memory address
        WRITE_CTRL_REG      =  0x1C,    ///< Write to the control Register
        READ_CTRL_REG       =  0x20,    ///< Read from the control Register
        SW_SHUTDOWN         =  0x24,    ///< Software shutdown (0) - Normal, (1) - Shutdown
        HI_Zupper           =  0x80,    ///< Get the SDO line ready for High Z
        HI_Zlower           =  0x01,    ///< Puts AD5270 into High Z mode
        HI_Z_Cmd            =  0x8001   ///< Puts AD5270 into High Z mode*/
    } AD5270Commands_t;

    typedef enum {
        NORMAL_MODE = 0,
        SHUTDOWN_MODE = 1
    } AD5270Modes_t;

    typedef enum {
        PROGRAM_50TP_ENABLE = 1,
        RDAC_WRITE_PROTECT = 2,
        R_PERFORMANCE_ENABLE = 4,
        MEMORY_PROGRAM_SUCCESFUL = 8
    } AD5270ControlRegisterBits_t;


    uint16_t AD5270_CalcRDAC(float resistance);
    float AD5270_WriteRDAC(float resistance);
    float AD5270_read_RDAC(void);
    float AD5270_ReadRDAC(void);
    void AD5270_Set_SDO_HiZ(void);
    void AD5270_Enable_50TP_Programming(void);
    void AD5270_Store_50TP(void);
    void AD5270_Disable_50TP_Programming(void);
    uint8_t AD5270_Read_50TP_LastAddress(void);
    void AD5270_ResetRDAC(void);
    void AD5270_ChangeMode(AD5270Modes_t mode);
    uint16_t AD5270_ReadReg(uint8_t command);
    void AD5270_WriteReg(uint8_t command, uint16_t value);


#endif
